<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
 <head>
  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  <title>Add collection document</title>
<link media="all" rel="stylesheet" type="text/css" href="styles/03e73060321a0a848018724a6c83de7f-theme-base.css" />
<link media="all" rel="stylesheet" type="text/css" href="styles/03e73060321a0a848018724a6c83de7f-theme-medium.css" />

 </head>
 <body class="docs"><div class="navbar navbar-fixed-top">
  <div class="navbar-inner clearfix">
    <ul class="nav" style="width: 100%">
      <li style="float: left;"><a href="class.mysql-xdevapi-collection.html">« mysql_xdevapi\Collection</a></li>
      <li style="float: right;"><a href="mysql-xdevapi-collection.addorreplaceone.html">Collection::addOrReplaceOne »</a></li>
    </ul>
  </div>
</div>
<div id="breadcrumbs" class="clearfix">
  <ul class="breadcrumbs-container">
    <li><a href="index.html">PHP Manual</a></li>
    <li><a href="class.mysql-xdevapi-collection.html">mysql_xdevapi\Collection</a></li>
    <li>Add collection document</li>
  </ul>
</div>
<div id="layout">
  <div id="layout-content"><div id="mysql-xdevapi-collection.add" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">Collection::add</h1>
  <p class="verinfo">(No version information available, might only be in Git)</p><p class="refpurpose"><span class="refname">Collection::add</span> &mdash; <span class="dc-title">Add collection document</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-mysql-xdevapi-collection.add-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>mysql_xdevapi\Collection::add</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.declarations.html#language.types.declarations.mixed" class="type mixed">mixed</a></span> <code class="parameter">$document</code></span>): <span class="type"><a href="class.mysql-xdevapi-collectionadd.html" class="type mysql_xdevapi\CollectionAdd">mysql_xdevapi\CollectionAdd</a></span></div>

  <p class="para rdfs-comment">
   Triggers the insertion of the given document(s) into the collection, and 
   multiple variants of this method are supported. Options include:
  </p>
  <ol type="1">
   <li class="listitem">
     <p class="para">
      Add a single document as a JSON string.
     </p>
   </li>
   <li class="listitem">
     <p class="para">
      Add a single document as an array as: 
      <code class="literal">[ &#039;field&#039; =&gt; &#039;value&#039;, &#039;field2&#039; =&gt; &#039;value2&#039; ... ]</code>
    </p>
   </li>
   <li class="listitem">
    <p class="para">
      A mix of both, and multiple documents can be added in the same operation.
    </p>
   </li>
  </ol>
 </div>


 <div class="refsect1 parameters" id="refsect1-mysql-xdevapi-collection.add-parameters">
  <h3 class="title">参数</h3>
  <dl>
   
    <dt>
<code class="parameter">document</code></dt>

    <dd>

     <p class="para">
      One or multiple documents, and this can be either JSON or an array of fields with 
      their associated values. This cannot be an empty array.
     </p>
     <p class="para">
      The MySQL server automatically generates unique <code class="literal">_id</code> values for
      each document (recommended), although this can be manually added as well. This value must be
      unique as otherwise the add operation will fail.
     </p>
    </dd>

   
  </dl>

 </div>


 <div class="refsect1 returnvalues" id="refsect1-mysql-xdevapi-collection.add-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="para">
   A CollectionAdd object. Use execute() to return a Result that can be used to query the number 
   of affected items, the number warnings generated by the operation, or to fetch a list of 
   generated IDs for the inserted documents.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-mysql-xdevapi-collection.add-examples">
  <h3 class="title">范例</h3>
  <div class="example" id="example-1556">
   <p><strong>示例 #1 <span class="function"><strong>mysql_xdevapi\Collection::add()</strong></span> example</strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br />$session&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">mysql_xdevapi</span><span style="color: #007700">\</span><span style="color: #0000BB">getSession</span><span style="color: #007700">(</span><span style="color: #DD0000">"mysqlx://user:password@localhost"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$session</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">sql</span><span style="color: #007700">(</span><span style="color: #DD0000">"DROP&nbsp;DATABASE&nbsp;IF&nbsp;EXISTS&nbsp;addressbook"</span><span style="color: #007700">)-&gt;</span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$session</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">sql</span><span style="color: #007700">(</span><span style="color: #DD0000">"CREATE&nbsp;DATABASE&nbsp;addressbook"</span><span style="color: #007700">)-&gt;</span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">$schema&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">$session</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getSchema</span><span style="color: #007700">(</span><span style="color: #DD0000">"addressbook"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$create&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">$schema</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">createCollection</span><span style="color: #007700">(</span><span style="color: #DD0000">"people"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$collection&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">$schema</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getCollection</span><span style="color: #007700">(</span><span style="color: #DD0000">"people"</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">//&nbsp;Add&nbsp;two&nbsp;documents<br /></span><span style="color: #0000BB">$collection</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">add</span><span style="color: #007700">(</span><span style="color: #DD0000">'{"name":&nbsp;"Fred",&nbsp;&nbsp;"age":&nbsp;21,&nbsp;"job":&nbsp;"Construction"}'</span><span style="color: #007700">)-&gt;</span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$collection</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">add</span><span style="color: #007700">(</span><span style="color: #DD0000">'{"name":&nbsp;"Wilma",&nbsp;"age":&nbsp;23,&nbsp;"job":&nbsp;"Teacher"}'</span><span style="color: #007700">)-&gt;</span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000">//&nbsp;Add&nbsp;two&nbsp;documents&nbsp;using&nbsp;a&nbsp;single&nbsp;JSON&nbsp;object<br /></span><span style="color: #0000BB">$result&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">$collection</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">add</span><span style="color: #007700">(<br />&nbsp;&nbsp;</span><span style="color: #DD0000">'{"name":&nbsp;"Bernie",<br />&nbsp;&nbsp;&nbsp;&nbsp;"jobs":&nbsp;[{"title":"Cat&nbsp;Herder","Salary":42000},&nbsp;{"title":"Father","Salary":0}],<br />&nbsp;&nbsp;&nbsp;&nbsp;"hobbies":&nbsp;["Sports","Making&nbsp;cupcakes"]}'</span><span style="color: #007700">,<br />&nbsp;&nbsp;</span><span style="color: #DD0000">'{"name":&nbsp;"Jane",<br />&nbsp;&nbsp;&nbsp;&nbsp;"jobs":&nbsp;[{"title":"Scientist","Salary":18000},&nbsp;{"title":"Mother","Salary":0}],<br />&nbsp;&nbsp;&nbsp;&nbsp;"hobbies":&nbsp;["Walking","Making&nbsp;pies"]}'</span><span style="color: #007700">)-&gt;</span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000">//&nbsp;Fetch&nbsp;a&nbsp;list&nbsp;of&nbsp;generated&nbsp;ID's&nbsp;from&nbsp;the&nbsp;last&nbsp;add()<br /></span><span style="color: #0000BB">$ids&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">$result</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getGeneratedIds</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$ids</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</code></div>
   </div>

   <div class="example-contents"><p>以上例程的输出类似于：</p></div>
   <div class="example-contents screen">
<div class="cdata"><pre>
Array
(
    [0] =&gt; 00005b6b53610000000000000056
    [1] =&gt; 00005b6b53610000000000000057
)
</pre></div>
   </div>
  </div>
 </div>


 <div class="refsect1 notes" id="refsect1-mysql-xdevapi-collection.add-notes">
  <h3 class="title">注释</h3>
  <blockquote class="note"><p><strong class="note">注意</strong>: 
   <p class="para">
    A unique _id is generated by MySQL Server 8.0 or higher, as demonstrated 
    in the example. The _id field must be manually defined if using
    MySQL Server 5.7.
   </p>
  </p></blockquote>
 </div>
 

</div></div></div></body></html>